Package com.getsensibill.core.apimodule.exports.model

Types

CompletedExport
Link copied to clipboard
data class CompletedExport(destructionTime: OffsetDateTime, createdAt: OffsetDateTime, updatedAt: OffsetDateTime, resultSize: Int, criteria: ExportItemCriteria?, outputFormats: List<ExportFormat>, documentIds: List<String>, id: String, completionTime: OffsetDateTime, fileUrl: String, fileSize: Int)
An additional convenience Export model that is used to represent a "completed" (ExportStatus.COMPLETED) export.
CreateExportPayload
Link copied to clipboard
data class CreateExportPayload(outputFormats: List<ExportFormat>, criteria: ExportItemCriteria, localeCode: String?)
Payload object used to provide export creation parameters to the API
CreateExportResponse
Link copied to clipboard
data class CreateExportResponse(destructionTime: OffsetDateTime, createdAt: OffsetDateTime, criteria: ExportItemCriteria, outputFormats: List<ExportFormat>, documentsCount: BigDecimal, status: ExportStatus, id: String)
The Response payload received when creating an export.
Export
Link copied to clipboard
data class Export(destructionTime: OffsetDateTime, createdAt: OffsetDateTime, updatedAt: OffsetDateTime, resultSize: Int, criteria: ExportItemCriteria?, outputFormats: List<ExportFormat>, documentIds: List<String>, status: ExportStatus, id: String, completionTime: OffsetDateTime?, fileUrl: String?, fileSize: Int?)
Model containing all the properties of a created Document Export.
ExportFormat
Link copied to clipboard
enum ExportFormat : Enum<ExportFormat> , KeyedEnum
The set of possible export formats
ExportItemCriteria
Link copied to clipboard
data class ExportItemCriteria(accountMetadataAccount: List<String>?, accountMetadataAccountExists: Boolean?, accountMetadataTransactionId: List<String>?, accountMetadataTransactionIdExists: Boolean?, amountDue: List<BigDecimal>?, amountDueGte: BigDecimal?, amountDueLte: BigDecimal?, arrivalDateTimeGte: OffsetDateTime?, arrivalDateTimeLte: OffsetDateTime?, categoryCode: List<String>?, currencyCode: List<String>?, description: List<String>?, documentDate: List<LocalDate>?, documentDateGte: LocalDate?, documentDateLte: LocalDate?, documentNumber: List<String>?, documentTime: List<String>?, documentTimeGte: String?, documentTimeLte: String?, documentType: List<DocumentTypeEnum>?, foreignId: List<String>?, id: List<String>?, lastUpdateDateTimeGte: OffsetDateTime?, lastUpdateDateTimeLte: OffsetDateTime?, merchantName: List<String>?, merchantTaxIdNumber: List<String>?, paymentTender: List<TenderTypesEnum>?, total: List<BigDecimal>?, totalGte: BigDecimal?, totalLte: BigDecimal?, status: List<DocumentStatusTypeEnum>?, sourceFormat: List<DocumentSourceFormatsEnum>?)
Document filter criteria that can be used in order to generate an export.
ExportStatus
Link copied to clipboard
enum ExportStatus : Enum<ExportStatus> , KeyedEnum
Enum representing the different possible export server statuses.